4.10.1 申请发送SPA安全码

基本信息 申请发送SPA安全码,为某个用户申请SPA安全码,已经存在安全码,直接发送,没有的生成新的安全码,过期的续期安全码,且以短信或者邮件形式分发下去(从2.6.5版本开始支持以邮件形式分发)

Path: /api/v1/spa/sendSpaCode

Method: POST

接口描述:

  1. 校验传入的用户信息,匹配则发送安全码短信或邮件给终端用户,不匹配则返回用户不存在。
  2. 接口适用于 v2.2.10 及以上版本。
  3. 一次一码模式下,每次申请会重置激活码,激活码过期时间由控制台安全码管理界面参数控制。
  4. 一次一码模式下,expiredTime参数会修改安全码的过期时间。
  5. v2.6.5 及以上版本支持通过邮件发送验证码,如需使用,请在“系统管理 - 系统配置 -> 消息网关”配置邮件网关,并在“安全中心 - 隐身服务”配置使用“邮件网关”推送安全码服务

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

名称 类型 是否必须 默认值 备注
name string 非必须 用户名
userDirectoryName string 必须 用户所在目录名( 必须传用户所在目录名
expiredTime string 非必须 0:永不过期 过期时间,时间戳,10位长度,单位秒,默认值0(永不过期),如不传则重置时默认0
sendMode string[] 非必须 ["sms"] 发送模式:sms (短信或邮件发送)
timeout number 非必须 30 发送短信/邮件超时时间,单位: 秒,范围:5-60s(适用于 v2.6.6 及以上版本)

请求示例

{
    "name": "111111",
    "phone": "15212345679",
    "userDirectoryName": "xxx",
    "expiredTime":"0",
    "sendMode":["sms"],
    "timeout": 30
}

返回数据

名称 类型 是否必须 备注
code number 必须 返回编码 0 成功 其它值,失败
data object 必须
msg string 必须 code对应的提示信息

返回示例

{
    "code": 0,
    "data": {
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
参数检查出错 10000001
用户不存在 10000021
当前安全码为共享码模式, 无法进行此操作, 请先更改安全码模式并保存后重试 10000022
未找到配置的安全码分发网关 10000022
用户已过期 10000023
用户被禁用 10000024
超过每日短信发送次数限制 75500402
参数类型schema校验失败 7201
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2026-01-21 17:02

results matching ""

    No results matching ""